Skip to main content

Checkbox

To add label to checkbox, use `Label` component next to it or wrap with `FieldContainer` or other way to display label next to Checkbox.
<FieldContainer display="inline" label={label} labelPosition="right">
<Checkbox {...} />
</FieldContainer>
Intersection of
ControlDisplayProps
ControlDisplayProps
className
string
distinction
ControlDistinction
id
string
intent
Intent
name
string
placeholder
| null| string
scheme
Scheme
size
Size
style
React.CSSProperties
type
undefined
ValidationStateProps
ValidationStateProps
onValidationStateChange
(error?: string) => void
validationState
ValidationState
ControlStateProps
ControlStateProps
active
boolean
disabled
boolean
focused
boolean
hovered
boolean
loading
boolean
readOnly
boolean
required
boolean
ControlFocusProps
ControlFocusProps
onBlur
() => void
onFocus
() => void
onFocusChange
(isFocused: boolean) => void
ControlConstraintProps
ControlConstraintProps
max
| null| boolean
maxLength
number
min
| null| boolean
minLength
number
pattern
string
step
number
ControlValueProps
ControlValueProps
defaultValue
| null| boolean
notNull
boolean
onChange
(value?: | null| boolean) => void
value
| null| boolean
__type
CheckboxButtonComponent
(__namedParameters: CheckboxButtonProps) => __global.JSX.Element
children
undefined
RestHTMLCheckboxProps
RestHTMLCheckboxProps
about
string
accept
string
acceptCharset
string
accessKey
string
action
string
allowFullScreen
boolean
allowTransparency
boolean
alt
string
aria-activedescendant
string
aria-atomic
Booleanish
aria-autocomplete
| "list"| "none"| "inline"| "both"
aria-busy
Booleanish
aria-checked
| boolean| "true"| "false"| "mixed"
aria-colcount
number
aria-colindex
number
aria-colspan
number
aria-controls
string
aria-current
| boolean| "time"| "page"| "true"| "false"| "step"| "location"| "date"
aria-describedby
string
aria-details
string
aria-disabled
Booleanish
aria-dropeffect
| "link"| "copy"| "none"| "execute"| "move"| "popup"
aria-errormessage
string
aria-expanded
Booleanish
aria-flowto
string
aria-grabbed
Booleanish
aria-haspopup
| boolean| "dialog"| "menu"| "true"| "false"| "grid"| "listbox"| "tree"
aria-hidden
Booleanish
aria-invalid
| boolean| "true"| "false"| "grammar"| "spelling"
aria-keyshortcuts
string
aria-label
string
aria-labelledby
string
aria-level
number
aria-live
| "off"| "assertive"| "polite"
aria-modal
Booleanish
aria-multiline
Booleanish
aria-multiselectable
Booleanish
aria-orientation
| "horizontal"| "vertical"
aria-owns
string
aria-placeholder
string
aria-posinset
number
aria-pressed
| boolean| "true"| "false"| "mixed"
aria-readonly
Booleanish
aria-relevant
| "text"| "additions"| "additions removals"| "additions text"| "all"| "removals"| "removals additions"| "removals text"| "text additions"| "text removals"
aria-required
Booleanish
aria-roledescription
string
aria-rowcount
number
aria-rowindex
number
aria-rowspan
number
aria-selected
Booleanish
aria-setsize
number
aria-sort
| "none"| "ascending"| "descending"| "other"
aria-valuemax
number
aria-valuemin
number
aria-valuenow
number
aria-valuetext
string
as
string
async
boolean
autoCapitalize
string
autoComplete
string
autoCorrect
string
autoFocus
boolean
autoPlay
boolean
autoSave
string
capture
| boolean| "user"| "environment"
cellPadding
| string| number
cellSpacing
| string| number
challenge
string
charSet
string
cite
string
classID
string
colSpan
number
color
string
cols
number
content
string
contentEditable
| Booleanish| "inherit"
contextMenu
string
controls
boolean
coords
string
crossOrigin
| ""| "anonymous"| "use-credentials"
dangerouslySetInnerHTML
data
string
datatype
string
dateTime
string
default
boolean
defaultChecked
boolean
defer
boolean
dir
string
download
any
draggable
Booleanish
encType
string
form
string
formAction
string
formEncType
string
formMethod
string
formNoValidate
boolean
formTarget
string
frameBorder
| string| number
headers
string
height
| string| number
hidden
boolean
high
number
href
string
hrefLang
string
htmlFor
string
httpEquiv
string
inlist
any
inputMode
| "search"| "text"| "none"| "tel"| "url"| "email"| "numeric"| "decimal"
integrity
string
is
string
itemID
string
itemProp
string
itemRef
string
itemScope
boolean
itemType
string
keyParams
string
keyType
string
kind
string
label
string
lang
string
list
string
loop
boolean
low
number
manifest
string
marginHeight
number
marginWidth
number
media
string
mediaGroup
string
method
string
multiple
boolean
muted
boolean
noValidate
boolean
nonce
string
onAbort
React.ReactEventHandler<HTMLInputElement>
onAbortCapture
React.ReactEventHandler<HTMLInputElement>
onAnimationEnd
React.AnimationEventHandler<HTMLInputElement>
onAnimationEndCapture
React.AnimationEventHandler<HTMLInputElement>
onAnimationIteration
React.AnimationEventHandler<HTMLInputElement>
onAnimationIterationCapture
React.AnimationEventHandler<HTMLInputElement>
onAnimationStart
React.AnimationEventHandler<HTMLInputElement>
onAnimationStartCapture
React.AnimationEventHandler<HTMLInputElement>
onAuxClick
React.MouseEventHandler<HTMLInputElement>
onAuxClickCapture
React.MouseEventHandler<HTMLInputElement>
onBeforeInput
React.FormEventHandler<HTMLInputElement>
onBeforeInputCapture
React.FormEventHandler<HTMLInputElement>
onBlurCapture
React.FocusEventHandler<HTMLInputElement>
onCanPlay
React.ReactEventHandler<HTMLInputElement>
onCanPlayCapture
React.ReactEventHandler<HTMLInputElement>
onCanPlayThrough
React.ReactEventHandler<HTMLInputElement>
onCanPlayThroughCapture
React.ReactEventHandler<HTMLInputElement>
onChangeCapture
React.FormEventHandler<HTMLInputElement>
onClick
React.MouseEventHandler<HTMLInputElement>
onClickCapture
React.MouseEventHandler<HTMLInputElement>
onCompositionEnd
React.CompositionEventHandler<HTMLInputElement>
onCompositionEndCapture
React.CompositionEventHandler<HTMLInputElement>
onCompositionStart
React.CompositionEventHandler<HTMLInputElement>
onCompositionStartCapture
React.CompositionEventHandler<HTMLInputElement>
onCompositionUpdate
React.CompositionEventHandler<HTMLInputElement>
onCompositionUpdateCapture
React.CompositionEventHandler<HTMLInputElement>
onContextMenu
React.MouseEventHandler<HTMLInputElement>
onContextMenuCapture
React.MouseEventHandler<HTMLInputElement>
onCopy
React.ClipboardEventHandler<HTMLInputElement>
onCopyCapture
React.ClipboardEventHandler<HTMLInputElement>
onCut
React.ClipboardEventHandler<HTMLInputElement>
onCutCapture
React.ClipboardEventHandler<HTMLInputElement>
onDoubleClick
React.MouseEventHandler<HTMLInputElement>
onDoubleClickCapture
React.MouseEventHandler<HTMLInputElement>
onDrag
React.DragEventHandler<HTMLInputElement>
onDragCapture
React.DragEventHandler<HTMLInputElement>
onDragEnd
React.DragEventHandler<HTMLInputElement>
onDragEndCapture
React.DragEventHandler<HTMLInputElement>
onDragEnter
React.DragEventHandler<HTMLInputElement>
onDragEnterCapture
React.DragEventHandler<HTMLInputElement>
onDragExit
React.DragEventHandler<HTMLInputElement>
onDragExitCapture
React.DragEventHandler<HTMLInputElement>
onDragLeave
React.DragEventHandler<HTMLInputElement>
onDragLeaveCapture
React.DragEventHandler<HTMLInputElement>
onDragOver
React.DragEventHandler<HTMLInputElement>
onDragOverCapture
React.DragEventHandler<HTMLInputElement>
onDragStart
React.DragEventHandler<HTMLInputElement>
onDragStartCapture
React.DragEventHandler<HTMLInputElement>
onDrop
React.DragEventHandler<HTMLInputElement>
onDropCapture
React.DragEventHandler<HTMLInputElement>
onDurationChange
React.ReactEventHandler<HTMLInputElement>
onDurationChangeCapture
React.ReactEventHandler<HTMLInputElement>
onEmptied
React.ReactEventHandler<HTMLInputElement>
onEmptiedCapture
React.ReactEventHandler<HTMLInputElement>
onEncrypted
React.ReactEventHandler<HTMLInputElement>
onEncryptedCapture
React.ReactEventHandler<HTMLInputElement>
onEnded
React.ReactEventHandler<HTMLInputElement>
onEndedCapture
React.ReactEventHandler<HTMLInputElement>
onError
React.ReactEventHandler<HTMLInputElement>
onErrorCapture
React.ReactEventHandler<HTMLInputElement>
onFocusCapture
React.FocusEventHandler<HTMLInputElement>
onGotPointerCapture
React.PointerEventHandler<HTMLInputElement>
onGotPointerCaptureCapture
React.PointerEventHandler<HTMLInputElement>
onInput
React.FormEventHandler<HTMLInputElement>
onInputCapture
React.FormEventHandler<HTMLInputElement>
onInvalid
React.FormEventHandler<HTMLInputElement>
onInvalidCapture
React.FormEventHandler<HTMLInputElement>
onKeyDown
React.KeyboardEventHandler<HTMLInputElement>
onKeyDownCapture
React.KeyboardEventHandler<HTMLInputElement>
onKeyPress
React.KeyboardEventHandler<HTMLInputElement>
onKeyPressCapture
React.KeyboardEventHandler<HTMLInputElement>
onKeyUp
React.KeyboardEventHandler<HTMLInputElement>
onKeyUpCapture
React.KeyboardEventHandler<HTMLInputElement>
onLoad
React.ReactEventHandler<HTMLInputElement>
onLoadCapture
React.ReactEventHandler<HTMLInputElement>
onLoadStart
React.ReactEventHandler<HTMLInputElement>
onLoadStartCapture
React.ReactEventHandler<HTMLInputElement>
onLoadedData
React.ReactEventHandler<HTMLInputElement>
onLoadedDataCapture
React.ReactEventHandler<HTMLInputElement>
onLoadedMetadata
React.ReactEventHandler<HTMLInputElement>
onLoadedMetadataCapture
React.ReactEventHandler<HTMLInputElement>
onLostPointerCapture
React.PointerEventHandler<HTMLInputElement>
onLostPointerCaptureCapture
React.PointerEventHandler<HTMLInputElement>
onMouseDown
React.MouseEventHandler<HTMLInputElement>
onMouseDownCapture
React.MouseEventHandler<HTMLInputElement>
onMouseEnter
React.MouseEventHandler<HTMLInputElement>
onMouseLeave
React.MouseEventHandler<HTMLInputElement>
onMouseMove
React.MouseEventHandler<HTMLInputElement>
onMouseMoveCapture
React.MouseEventHandler<HTMLInputElement>
onMouseOut
React.MouseEventHandler<HTMLInputElement>
onMouseOutCapture
React.MouseEventHandler<HTMLInputElement>
onMouseOver
React.MouseEventHandler<HTMLInputElement>
onMouseOverCapture
React.MouseEventHandler<HTMLInputElement>
onMouseUp
React.MouseEventHandler<HTMLInputElement>
onMouseUpCapture
React.MouseEventHandler<HTMLInputElement>
onPaste
React.ClipboardEventHandler<HTMLInputElement>
onPasteCapture
React.ClipboardEventHandler<HTMLInputElement>
onPause
React.ReactEventHandler<HTMLInputElement>
onPauseCapture
React.ReactEventHandler<HTMLInputElement>
onPlay
React.ReactEventHandler<HTMLInputElement>
onPlayCapture
React.ReactEventHandler<HTMLInputElement>
onPlaying
React.ReactEventHandler<HTMLInputElement>
onPlayingCapture
React.ReactEventHandler<HTMLInputElement>
onPointerCancel
React.PointerEventHandler<HTMLInputElement>
onPointerCancelCapture
React.PointerEventHandler<HTMLInputElement>
onPointerDown
React.PointerEventHandler<HTMLInputElement>
onPointerDownCapture
React.PointerEventHandler<HTMLInputElement>
onPointerEnter
React.PointerEventHandler<HTMLInputElement>
onPointerEnterCapture
React.PointerEventHandler<HTMLInputElement>
onPointerLeave
React.PointerEventHandler<HTMLInputElement>
onPointerLeaveCapture
React.PointerEventHandler<HTMLInputElement>
onPointerMove
React.PointerEventHandler<HTMLInputElement>
onPointerMoveCapture
React.PointerEventHandler<HTMLInputElement>
onPointerOut
React.PointerEventHandler<HTMLInputElement>
onPointerOutCapture
React.PointerEventHandler<HTMLInputElement>
onPointerOver
React.PointerEventHandler<HTMLInputElement>
onPointerOverCapture
React.PointerEventHandler<HTMLInputElement>
onPointerUp
React.PointerEventHandler<HTMLInputElement>
onPointerUpCapture
React.PointerEventHandler<HTMLInputElement>
onProgress
React.ReactEventHandler<HTMLInputElement>
onProgressCapture
React.ReactEventHandler<HTMLInputElement>
onRateChange
React.ReactEventHandler<HTMLInputElement>
onRateChangeCapture
React.ReactEventHandler<HTMLInputElement>
onReset
React.FormEventHandler<HTMLInputElement>
onResetCapture
React.FormEventHandler<HTMLInputElement>
onResize
React.ReactEventHandler<HTMLInputElement>
onResizeCapture
React.ReactEventHandler<HTMLInputElement>
onScroll
React.UIEventHandler<HTMLInputElement>
onScrollCapture
React.UIEventHandler<HTMLInputElement>
onSeeked
React.ReactEventHandler<HTMLInputElement>
onSeekedCapture
React.ReactEventHandler<HTMLInputElement>
onSeeking
React.ReactEventHandler<HTMLInputElement>
onSeekingCapture
React.ReactEventHandler<HTMLInputElement>
onSelect
React.ReactEventHandler<HTMLInputElement>
onSelectCapture
React.ReactEventHandler<HTMLInputElement>
onStalled
React.ReactEventHandler<HTMLInputElement>
onStalledCapture
React.ReactEventHandler<HTMLInputElement>
onSubmit
React.FormEventHandler<HTMLInputElement>
onSubmitCapture
React.FormEventHandler<HTMLInputElement>
onSuspend
React.ReactEventHandler<HTMLInputElement>
onSuspendCapture
React.ReactEventHandler<HTMLInputElement>
onTimeUpdate
React.ReactEventHandler<HTMLInputElement>
onTimeUpdateCapture
React.ReactEventHandler<HTMLInputElement>
onTouchCancel
React.TouchEventHandler<HTMLInputElement>
onTouchCancelCapture
React.TouchEventHandler<HTMLInputElement>
onTouchEnd
React.TouchEventHandler<HTMLInputElement>
onTouchEndCapture
React.TouchEventHandler<HTMLInputElement>
onTouchMove
React.TouchEventHandler<HTMLInputElement>
onTouchMoveCapture
React.TouchEventHandler<HTMLInputElement>
onTouchStart
React.TouchEventHandler<HTMLInputElement>
onTouchStartCapture
React.TouchEventHandler<HTMLInputElement>
onTransitionEnd
React.TransitionEventHandler<HTMLInputElement>
onTransitionEndCapture
React.TransitionEventHandler<HTMLInputElement>
onVolumeChange
React.ReactEventHandler<HTMLInputElement>
onVolumeChangeCapture
React.ReactEventHandler<HTMLInputElement>
onWaiting
React.ReactEventHandler<HTMLInputElement>
onWaitingCapture
React.ReactEventHandler<HTMLInputElement>
onWheel
React.WheelEventHandler<HTMLInputElement>
onWheelCapture
React.WheelEventHandler<HTMLInputElement>
open
boolean
optimum
number
playsInline
boolean
poster
string
prefix
string
preload
string
property
string
radioGroup
string
rel
string
resource
string
results
number
rev
string
reversed
boolean
role
React.AriaRole
rowSpan
number
rows
number
sandbox
string
scope
string
scoped
boolean
scrolling
string
seamless
boolean
security
string
selected
boolean
shape
string
sizes
string
slot
string
span
number
spellCheck
Booleanish
src
string
srcDoc
string
srcLang
string
srcSet
string
start
number
summary
string
suppressContentEditableWarning
boolean
suppressHydrationWarning
boolean
tabIndex
number
target
string
title
string
translate
| "yes"| "no"
typeof
string
unselectable
| "on"| "off"
useMap
string
vocab
string
width
| string| number
wmode
string
wrap
string
React.RefAttributes